docs(infiniteLoading): optimize target description #2770
Conversation
Walkthrough此次更改主要集中在 Changes
Possibly related PRs
Suggested labels
Suggested reviewers
Poem
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Outside diff range and nitpick comments (4)
src/packages/infiniteloading/doc.taro.md (1)
54-54: 属性描述更新清晰准确！新的描述很好地澄清了
target属性的实际用途，避免了开发者误解它用于 DOM 监听。这个改进对于防止错误使用非常重要。建议在示例代码部分添加一个多实例使用的演示，以帮助开发者更好地理解
target属性的实际应用场景。### 基础用法 :::demo <CodeBlock src='taro/demo1.tsx'></CodeBlock> ::: +### 多实例使用 + +:::demo + +<CodeBlock src='taro/demo-multiple-instances.tsx'></CodeBlock> + +::: + ### 下拉刷新src/packages/infiniteloading/doc.md (1)
63-63: 描述更新清晰准确，建议补充使用示例对
target属性的描述更新非常到位，明确指出了其真实用途是用于区分多个组件实例，而不是用于 DOM 监听，这样的澄清对开发者很有帮助。建议在文档中添加一个具体的代码示例，展示如何在同一页面上使用多个 InfiniteLoading 组件，并通过
target属性来区分它们。这将帮助开发者更好地理解这个属性的实际应用场景。例如：// 示例：同一页面使用多个 InfiniteLoading <InfiniteLoading target="list1" onLoadMore={loadMoreList1}> {/* 列表1内容 */} </InfiniteLoading> <InfiniteLoading target="list2" onLoadMore={loadMoreList2}> {/* 列表2内容 */} </InfiniteLoading>src/packages/infiniteloading/doc.zh-TW.md (1)
76-76: 修复文档中的链接片段链接片段
#/zh-CN/component/configprovider需要更新为正确的路径。建议修改为：
-请参考 [ConfigProvider 组件](#/zh-CN/component/configprovider) +请参考 [ConfigProvider 组件](#/zh-TW/component/configprovider)🧰 Tools
🪛 Markdownlint
76-76: null
Link fragments should be valid(MD051, link-fragments)
src/packages/infiniteloading/doc.en-US.md (1)
63-64: 描述更新清晰准确，建议进一步优化格式target属性的描述更新很好地澄清了其用途，有助于防止开发者误用。但建议将描述适当简化，使其更加简洁。
建议应用以下修改：
-| target | Used to identify and distinguish between multiple component instances on the page. Note that this attribute is not used for listening to DOM elements, but rather for managing multiple component instances on the same page. | -| `string` | `-` | +| target | 用于标识和区分页面上的多个组件实例（注意：不用于监听DOM元素） | `string` | `-` |🧰 Tools
🪛 Markdownlint
63-63: Expected: 4; Actual: 2; Too few cells, row will be missing data
Table column count(MD056, table-column-count)
64-64: Expected: 4; Actual: 2; Too few cells, row will be missing data
Table column count(MD056, table-column-count)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (4)
src/packages/infiniteloading/doc.en-US.md(1 hunks)src/packages/infiniteloading/doc.md(1 hunks)src/packages/infiniteloading/doc.taro.md(1 hunks)src/packages/infiniteloading/doc.zh-TW.md(1 hunks)
🧰 Additional context used
🪛 Markdownlint
src/packages/infiniteloading/doc.en-US.md
63-63: Expected: 4; Actual: 2; Too few cells, row will be missing data
Table column count
(MD056, table-column-count)
64-64: Expected: 4; Actual: 2; Too few cells, row will be missing data
Table column count
(MD056, table-column-count)
src/packages/infiniteloading/doc.zh-TW.md
76-76: null
Link fragments should be valid
(MD051, link-fragments)
🔇 Additional comments (1)
src/packages/infiniteloading/doc.zh-TW.md (1)
63-63: 优化了 target 属性的描述，使其更加清晰明确
新的描述更好地解释了 target 属性的实际用途，明确指出它是用于区分多个组件实例，而不是用于监听 DOM 元素。这个改进有助于避免开发者的误用。
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## next #2770 +/- ##
=======================================
Coverage 84.07% 84.07%
=======================================
Files 217 217
Lines 17830 17830
Branches 2609 2609
=======================================
Hits 14991 14991
Misses 2834 2834
Partials 5 5 ☔ View full report in Codecov by Sentry. 🚨 Try these New Features:
|
🤔 这个变动的性质是？
🔗 相关 Issue
💡 需求背景和解决方案
☑️ 请求合并前的自查清单
Summary by CodeRabbit
InfiniteLoading组件中target属性的描述，明确其用于区分页面上多个组件实例，而非监听DOM元素。target属性在文档中的格式，提高了可读性。